Skip to main content

Get-IMTimeBucket

SYNOPSIS​

Retrieves timeline time buckets.

SYNTAX​

list (Default)​

Get-IMTimeBucket [-Session <ImmichSession>] [-albumId <String>] [-isFavorite <Boolean>] [-isTrashed <Boolean>]
 [-order <String>] [-personId <String>] [-userId <String>] [-withPartners <Boolean>] [-withStacked <Boolean>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

timebucket​

Get-IMTimeBucket [-Session <ImmichSession>] [-albumId <String>] [-isFavorite <Boolean>] [-isTrashed <Boolean>]
 [-order <String>] [-personId <String>] -timeBucket <String> [-userId <String>] [-withPartners <Boolean>]
 [-withStacked <Boolean>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Gets time-based groupings of assets for timeline display and navigation.

EXAMPLES​

EXAMPLE 1​

Get-IMTimeBucket

Retreives timebucket

PARAMETERS​

-Session​

Optional session object for multi-instance connections.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-albumId​

Filter by album ID.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-isFavorite​

Filter by favorite status.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-isTrashed​

Filter by trash status.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-order​

Sort order for results.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Asc
Accept pipeline input: False
Accept wildcard characters: False

-personId​

Filter by person ID.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-timeBucket​

Timebucket

Type: String
Parameter Sets: timebucket
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-userId​

UserId filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-withPartners​

With partners filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-withStacked​

With stacked filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github